<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Faiss: faiss::MinSumK&lt; T, SSA, use_seen &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Faiss
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacefaiss.html">faiss</a></li><li class="navelem"><a class="el" href="structfaiss_1_1MinSumK.html">MinSumK</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structfaiss_1_1MinSumK-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">faiss::MinSumK&lt; T, SSA, use_seen &gt; Struct Template Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aa649f97b697150608b1874d88a613e92"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structfaiss_1_1CMin.html">CMin</a>&lt; T, long &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1MinSumK.html#aa649f97b697150608b1874d88a613e92">HC</a></td></tr>
<tr class="separator:aa649f97b697150608b1874d88a613e92"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2ba9c99ce74a44285d969abd033cefe4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ba9c99ce74a44285d969abd033cefe4"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>MinSumK</b> (int <a class="el" href="structfaiss_1_1MinSumK.html#a6cf625ac4c6933775bca98a6ec283ec8">K</a>, int <a class="el" href="structfaiss_1_1MinSumK.html#a816976ee9baa0378b01d2f0fdaf4907a">M</a>, int <a class="el" href="structfaiss_1_1MinSumK.html#a13f94071498f5a240b79e81346856658">N</a>)</td></tr>
<tr class="separator:a2ba9c99ce74a44285d969abd033cefe4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3c80c8175b546fa2434e89dab976356"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3c80c8175b546fa2434e89dab976356"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_seen</b> (long i)</td></tr>
<tr class="separator:af3c80c8175b546fa2434e89dab976356"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b21b5adb5e512a4e9f2c0a81aa0eb1f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b21b5adb5e512a4e9f2c0a81aa0eb1f"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>mark_seen</b> (long i)</td></tr>
<tr class="separator:a7b21b5adb5e512a4e9f2c0a81aa0eb1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6fce94fb08a3ea1108f0e3fb29dd008"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6fce94fb08a3ea1108f0e3fb29dd008"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>run</b> (const T *x, T *sums, long *terms)</td></tr>
<tr class="separator:ab6fce94fb08a3ea1108f0e3fb29dd008"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0738b68d9b713ea56894fde4639bb86b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0738b68d9b713ea56894fde4639bb86b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>enqueue_follower</b> (long ti, int m, int n, T sum)</td></tr>
<tr class="separator:a0738b68d9b713ea56894fde4639bb86b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a6cf625ac4c6933775bca98a6ec283ec8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6cf625ac4c6933775bca98a6ec283ec8"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1MinSumK.html#a6cf625ac4c6933775bca98a6ec283ec8">K</a></td></tr>
<tr class="memdesc:a6cf625ac4c6933775bca98a6ec283ec8"><td class="mdescLeft">&#160;</td><td class="mdescRight">nb of sums to return <br/></td></tr>
<tr class="separator:a6cf625ac4c6933775bca98a6ec283ec8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a816976ee9baa0378b01d2f0fdaf4907a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a816976ee9baa0378b01d2f0fdaf4907a"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1MinSumK.html#a816976ee9baa0378b01d2f0fdaf4907a">M</a></td></tr>
<tr class="memdesc:a816976ee9baa0378b01d2f0fdaf4907a"><td class="mdescLeft">&#160;</td><td class="mdescRight">nb of elements to sum up <br/></td></tr>
<tr class="separator:a816976ee9baa0378b01d2f0fdaf4907a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13f94071498f5a240b79e81346856658"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a13f94071498f5a240b79e81346856658"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1MinSumK.html#a13f94071498f5a240b79e81346856658">N</a></td></tr>
<tr class="memdesc:a13f94071498f5a240b79e81346856658"><td class="mdescLeft">&#160;</td><td class="mdescRight">nb of possible elements for each of the M terms <br/></td></tr>
<tr class="separator:a13f94071498f5a240b79e81346856658"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51b3cef2fb4556af1b88c697b2bc1579"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51b3cef2fb4556af1b88c697b2bc1579"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>heap_capacity</b></td></tr>
<tr class="separator:a51b3cef2fb4556af1b88c697b2bc1579"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5304f25f9894508de16f3ea95b8f3b34"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5304f25f9894508de16f3ea95b8f3b34"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>heap_size</b></td></tr>
<tr class="separator:a5304f25f9894508de16f3ea95b8f3b34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1d7564bf17930f1ae10f23d00907a3e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1d7564bf17930f1ae10f23d00907a3e"></a>
T *&#160;</td><td class="memItemRight" valign="bottom"><b>bh_val</b></td></tr>
<tr class="separator:aa1d7564bf17930f1ae10f23d00907a3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a867ef12babeeb3fe208428b9a5d02027"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a867ef12babeeb3fe208428b9a5d02027"></a>
long *&#160;</td><td class="memItemRight" valign="bottom"><b>bh_ids</b></td></tr>
<tr class="separator:a867ef12babeeb3fe208428b9a5d02027"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab20866946be59a5f68576a9ce9c93e25"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab20866946be59a5f68576a9ce9c93e25"></a>
std::vector&lt; SSA &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>ssx</b></td></tr>
<tr class="separator:ab20866946be59a5f68576a9ce9c93e25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae961416fb525a93703260897d2f5a0cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae961416fb525a93703260897d2f5a0cc"></a>
std::vector&lt; long &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>weights</b></td></tr>
<tr class="separator:ae961416fb525a93703260897d2f5a0cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc2a19e0bcc4b969f443678cc78b5e1d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc2a19e0bcc4b969f443678cc78b5e1d"></a>
std::vector&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>seen</b></td></tr>
<tr class="separator:acc2a19e0bcc4b969f443678cc78b5e1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T, class SSA, bool use_seen&gt;<br/>
struct faiss::MinSumK&lt; T, SSA, use_seen &gt;</h3>


<p>Definition at line <a class="el" href="IndexPQ_8cpp_source.html#l00650">650</a> of file <a class="el" href="IndexPQ_8cpp_source.html">IndexPQ.cpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="aa649f97b697150608b1874d88a613e92"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T, class SSA, bool use_seen&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="structfaiss_1_1CMin.html">CMin</a>&lt;T, long&gt; <a class="el" href="structfaiss_1_1MinSumK.html">faiss::MinSumK</a>&lt; T, SSA, use_seen &gt;::<a class="el" href="structfaiss_1_1MinSumK.html#aa649f97b697150608b1874d88a613e92">HC</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>the heap. We use a heap to maintain a queue of sums, with the associated terms involved in the sum. </p>

<p>Definition at line <a class="el" href="IndexPQ_8cpp_source.html#l00659">659</a> of file <a class="el" href="IndexPQ_8cpp_source.html">IndexPQ.cpp</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="IndexPQ_8cpp_source.html">IndexPQ.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
